post /mint/organizations/{org_name}/transaction-search

Gets transaction activity for the specified organization using the specified criteria. See also Reporting transaction activity using the API.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search

Path Parameters

org_name (required)

string

Organization name.

Query Parameters

all

boolean

Default value

false

Flag that specifies whether to return all records. If set to false, the number of records returned per page is defined by the size query parameter.

size

integer

Default value

Number of records returned per page. If the all query parameter is set to true, this parameter is ignored.

page

integer

Default value

Number of the page that you want to return (if content is paginated). If the all query parameter is set to true, this parameter is ignored.

Request Body

Criteria used to search for transactions.

application/json

MintCriteria

appCriteria

array

ID and organization for a specific application to be included in the report. If this property is not specified, all applications are included in the report.

object

id	string App ID.
orgId	string Organization name.

billingMonth

string

Billing month of the report, such as JULY.

Note: This property is not valid for revenue reports.

billingYear

string

Billing year for the report, such as 2015.

Note: This property is not valid for revenue reports.

currCriteria

array

ID and organization for a specific currency to be included in the report. If this property is not specified, all supported currencies are included in the report.

object

id	string Currency ID.
orgId	string Organization name.

currencyOption

string

Currency for the report. Valid values include:

LOCAL: Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.
EUR: Local currency transactions are converted and displayed in Euros.
GPB: Local currency transactions are converted and displayed in United Kingdom pounds.
USD: Local currency transactions are converted and displayed in United States dollars.

Note: If you select EUR, GBP, or USD, the report displays all transactions using that single currency, based on the exchange rate in effect on the date of the transaction.

devCriteria

array

Developer ID or email address, and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report.

object

id	string Developer ID.
orgId	string Organization name.

devCustomAttribute

array

Custom attributes to include in the report, if defined for a developer.

Note: This property is not valid for revenue reports. Do not specify the predefined MINT_* and ADMIN_* attributes in the devCustomAttributes array.

fromDate

string

Starting date and time of the report in UTC time. For example: 2017-01-15 01:30:00. You can omit the timestamp; if not specified it defaults to 00:00:00.

Note: This property applies only to revenue and variance reports.

groupBy

array

Order in which sections are grouped in the report. Enter the values in the desired order: APPLICATION, BALANCE, DEVELOPER, ORG, PACKAGE, PRODUCT, and RATEPLAN.

monetizationPackageIds

array

ID of one or more API packages to include in the report. If this property is not specified, all API packages are included inthe report.

Note: This property is not valid when viewing transaction activity (/transaction-search).

pkgCriteria

string

ID and organization for a specific API package to be included in the report. If this property is not specified, all API packages are included in the report. This property can be specified instead of the monetizationpackageIds property.

Note: This property is not valid when viewing transaction activity (/transaction-search).

prevFromDate

string

Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

prevToDate

string

Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

prodCriteria

string

ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the productIds property.

Note: This property is not valid when viewing transaction activity (/transaction-search).

productIds

array

ID of one or more API products to include in the report. If this property is not specified, all API products are included in the report.

API product IDs should be specified as org-name@@@product-name. For example: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

pricingTypes

array

Pricing type of rate plan to be included in the report. Valid values include:

REVSHARE: Revenue share plan.
REVSHARE_RATECARD: Revenue share and rate card rate plan.
RATECARD: Rate card plan. If this property is not specified, rate plans of all pricing types are included in the report.

ratePlanLevels

array

Type of rate plan to be included in the report. Valid values include:

DEVELOPER: Developer rate plan.
STANDARD: Standard rate plan.

If this property is not specified, both developer-specific and standard rate plans are included in the report.

showEntityId

boolean

Flag that specifies whether the reports shows the entity ID.

showRevSharePct

boolean

Flag that specifies whether the report shows revenue share percentages.

showSummary

boolean

Flag that specifies whether the report is a summary.

showTxDetail

boolean

Flag that specifies whether the report shows transaction level details.

Note: This property applies only to revenue reports.

showTxType

boolean

Flag that specifies whether the report shows the type of each transaction.

toDate

string

Ending date and time of the report in UTC time. For example: 2017-01-15 01:30:00. You can omit the timestamp; if not specified it defaults to 00:00:00.
Note: This property applies only to revenue and variance reports.

transactionStatus

array

Status of transactions to include in the report. Valid values include:

SUCCESS: Successful transactions.
FAILED: Failed transaction.
FINAL: Transactions marked as final.
REVIEW: Transaction marked as under review.

transactionCustomAttributes

array

Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports.

transactionTypes

array

Type of transactions to be included in the report. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, RECURRINGFEES, and TRUEUP. TRUEUPs are transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month. If this property is not specified, all transaction types are included in the report.

Response Types

200:

Body

application/json

Transactions

totalRecords

integer

Total number of records.

transaction

array

Details of the transactions.

Transaction

application

Application

description	string Description of the application.
id	string ID of the application.
name	string Name of the application.
organization	Organization
product	array

batchSize

number

Batch size of the transaction, if applicable.

currency

string

Type of currency. For example, USD.

developer

DeveloperInfo

if type is:

object

endTime

string

Time that the transaction ended.

environment

string

Environment, such as test or prod.

euroExchangeRate

number

European exchange rate, if applicable.

gbpExchangeRate

number

British pound exchange rate, if applicable.

string

Type of the transaction.

isVirtualCurrency

boolean

Flag that specifies whether the currency is virtual.

notes

string

Notes about the transaction.

parentId

string

ID of the purchase transaction that you are refunding. Applies to refunds only.

pkgId

string

API package ID.

pkgRatePlanProductName

string

Name of the API product in the API package.

product

APIProduct

customAtt1Name	string Custom attribute name. There may be zero or more custom attributes. For example, `customAtt1Name`, `customAtt2Name`, `customAtt3Name`, and so on.
description	string Description of API product.
displayName	string User-friendly display name of the API product.
id	string ID of the API product.
name	string Name of the API product.
organization	Organization
refundSuccessCriteria	string Expression that is compared to the value of the Status attribute and is used to determine when the refund transaction is successful (for charging purposes). For example: `txProviderStatus == 'OK'`. Not applicable to `POST` operations.
status	string Status indicator for the API product. Valid values include: `CREATED`, `ACTIVE`, `INACTIVE`. This value is maintained but not currently used by the API product.
transactionSuccessCriteria	string Expression that is compared to the value of the Status attribute and is used to determine when the transaction is successful (for charging purposes). For example: `txProviderStatus == 'OK`'. Not applicable to `POST` operations.

providerTxId

string

Transaction provider ID.

rate

number

Rate.

ratePlanLevel

string

Type of rate plan. Valid values include: STANDARD (all developers), DEVELOPER_CATEGORY (developers within a category), or DEVELOPER (specific developer).'

ratedVolume

number

Rated volume.

revenueShareAmount

number

Revenue share amount.

startTime

string

Time that the transaction started.

status

string

Status of the transaction.

taxModel

string

Tax model. Valid values include:

Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.
Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).
Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

txProviderStatus

string

Transaction provider status.

type

string

Type of transaction. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, TRUEUPS. TRUEUPS are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month.

usdExchangeRate

number

US exchange rate.

utcEndTime

string

Time that the transaction ended in UTC.

utcStartTime

string

Time that the transaction started in UTC.

Authentication Requirements

Available Authentication Options

Basic
OAuth

Monetization API

post /mint/organizations/{org_name}/transaction-search

HTTP request

Path Parameters

Query Parameters

Request Body

Response Types

200:

Body

Authentication Requirements

Try this API